BBS Toolkit/BBS Toolkit.iso/doors_1/blist194.zip/BLIST.DOC

Text File | 1992-12-19 | 20KB | 455 lines

        ┌─────────────────────────────────────────────────────────────┐
        │                      BBSLIST DOOR V1.94                     │
        │            A ProKit based Door for PCBoard 14.5a            │
        │    By Joseph Sheppard - The Ledge PCBoard [phone]    │
        └─────────────────────────────────────────────────────────────┘

    ───────────
    DESCRIPTION
    ───────────

    This door allows you and your users to create a BBS List. Once created
    the list can be Viewed with automatic paging, Scanned by keyword, or
    Downloaded in your choice of compression format with X-Y-Zmodem
    or Ymodem-G protocol.

    The "Add a BBS" feature can be toggled off by the Sysop so that you
    can use the door to display pre-made lists that your callers
    shouldn't add to.  Lists that show BBS info in a single line format
    will work best with this door.

    BList works with modems connected to standard and non-standard
    comports.  Fossil driver support is included for multi-port hardware.
    See the section titled NON-STANDARD PORTS in this document for more
    information.

    The following user created files are supported in both ASCII and ANSI:

    Welcome screen           (BLHELLO & BLHELLOG
    Menu screen              (BLMENU & BLMENUG)
    Goodbye Screen           (BLBYE & BLBYEG)

    The door will convert PCBoard @x color codes automatically.  If you are
    using these codes in your screens, you will not need a color and
    non-color version of each file.  The door will also convert all known
    PCBoard @VARIABLES@ on the fly.

    BBSList reports to the caller log all BBS's added, downloads and all
    invalid commands if configured to do so.

    It is REQUIRED that DSZ.COM or DSZ.EXE by Chuck Foresberg and PKZIP.EXE
    by Phil Katz or other file compression program be in either the DOS path,
    or the same directory as BLIST.EXE.

    It is REQUIRED that PCBSTATS.EXE, which is distributed with PCBoard
    14.5 be in your DOS path.  If it is missing, your call waiting screen
    will not be updated when a caller logs off inside the door.

    It is suggested that SORTF.COM by Vern Buerg be in either the DOS path
    or the same directory as BLIST.EXE. If SORTF.EXE is present, your list
    will be sorted by Area code each time a user adds a BBS. If you can't
    find SORTF.COM, then you can use any other ASCII sort filter, just edit
    the BLSORT.BAT file to reflect the correct commands for the sort
    program you choose.

    DSZ, PKZIP and SORTF are NOT included in this Archive. You can find
    these files on most BBS systems. They will always be available on my
    System if you have difficulty finding them.  If you call The Ledge, you
    will find that I have a mail-in validation rule, but you will find that
    you can open the LEDGE SUPPORT DOOR and download the latest version of
    BBSList along with all the third party support programs on your first
    call.

    ─────
    SETUP
    ─────

    Here is a description of the files you will need to get started:

    1. Filename:         BLIST.EXE
       Purpose:          BBSList program
       Location:         Any directory that includes BLIST.CNF
       Multi-Node Notes: One copy should be fine, Share is supported.

    2. Filename:         BLIST.CNF
       Purpose:          Defines parameters for BLIST.EXE
       Location:         Any directory that includes BLIST.EXE
       Multi-Node Notes: One copy of this should be able to handle all
                         nodes as the \PCB directory for each node is
                         pointed to in the BBSList file.

       Sample File:


       INTERRUPT
       Y
       PKZIP /A
       Y
       ZIP
       1
       Y
       D:\PCB\GEN\PCBSTATS.DAT

       Explanation:

       INTERRUPT: This is the communications driver type. Most systems will
       work with the Interrupt driver.  If you use a Fossil driver to
       communicate with special hardware such as a multi-port board, place
       the word FOSSIL on this line.  See the section titled NON-STANDARD
       PORTS in this document for more information regarding connections to
       other than standard COM1: and COM2:.

       Y: This is a "switch" that tells Blist weather or not you want it to
       stop and sort the bbslist after a caller enters a series of new BBS
       numbers.  Turn sorting on by putting the letter Y on this line, turn
       it off by putting the letter N on the line. If the switch is on,
       Blist will run a batch file called BLSORT.BAT. The BLSORT.BAT
       provided will run SORTF.COM by Vern Buerg, which is available on
       most BBS Systems. If you have another sort program you'd rather use,
       just change the commands in BLSORT.BAT to run your sort program. The
       reason this is left as an option is that it is possible to build
       such a large BBS list that you may run out of memory trying to sort
       the list.  If this happens turn the sorting off by putting a N on
       this line. Whatever you do, DON'T USE THE SORT PROGRAM THAT COMES
       WITH DOS!  I tried it on a big BBS List (300K) and before aborting,
       it truncated my BBS List to a 0K file!


       PKZIP /A: This line should reflect the command that you need to send
       to your compression program.  This makes BLIST compatible with most
       compression programs.  I have tested it with PKZIP, PKARC, LHARC and
       PAK.  I would imagine that most other compression programs will work
       as well as long as they follow the basic command syntax:
       <programname> <option> <result-filename> <files to add to
       result-filename>.  If the compression process aborts because of lack
       of memory, then you should try a compression program that uses less
       RAM. If nothing you find works, then put the word NONE on this line
       and the compression process will be skipped.  Your caller will be
       allowed to download the BBSLIST file in ASCII form.

       Y: Write to CALLER Log and DOWNLOAD.TXT? (Y/N).  If this line has a
       Y on it then BLIST will write details about what the caller did in
       your CALLERx log.  It will also log downloads to your DOWNLOAD.TXT
       file.  If you put a N on this line then BLIST will not write to
       these files.  Regardless of the setting, BLIST will not write to
       these files if you are on locally.

       ZIP: If you are using PKZIP to compress your BBSLIST file before
       download, then leave this alone.  If you are using another
       compression method, then replace this line with the file
       extension that your compression method uses (ARC, PAK, ZOO, etc).

       1: This is the security level you want users to be at or above in
       order to have access to the "Add a BBS" feature.  Set this very
       high if you want to use the BBSList door to display a set listing
       that none of your users should add to, such as the Darwin list.

       Y: Use Automatic Colorization? (Y/N).  If you put a Y on this
       line then the BBS List will be automatically colorized when
       viewed.  If you put a N on this line it will be displayed without
       color, unless you have a special colorized file called BBSLISTG.
       This toggle is mainly for Sysops using the door to display
       pre-made lists.  The colorization routine depends on the list
       being laid out exactly as the door creates it, so colorization of
       a pre-made list may yield bizarre results.

       D:\PCB\GEN\PCBSTATS.DAT: This is the location of your PCBSTATS.DAT
       file.  Leave this blank if you don't want your call waiting screen
       to be updated by the door.  PCBSTATS.EXE, which is distributed with
       PCBoard 14.5 is REQUIRED for this to work.  It must be in your DOS
       path.



    3. Filename:           BLIST
       Purpose:            Used by PCBoard to run the BBSList door
       Location:           Your Main PCBoard directory (for example C:\PCB)
       Multi-Node  Notes:  One  in each PCBoard directory (example C:\PCB1,
                           C:\PCB2,  C:\PCB3).  Change DSZPORT parameter to
                           reflect your comport number.

       Sample file:


       cd\pcb\doors
       set dszport=1
       rem PKZIP bbslst bbslist
       blist blist.cnf d:\pcb
       cd\pcb
       if exist event.bat event
       board


       Explanation:

       CD \PCB\DOORS: changes to the directory where you have stored your
       BLIST.EXE and BLIST.CNF files. Change this line to reflect the drive
       and directory you are using to store these files.

       SET DSZPORT=1: This tells DSZ what port you are using. If you are on
       com2 then change it to SET DSZPORT=2.  It's VERY important that
       multi-node systems change this parameter in each \PCBx directory to
       show what port dsz needs to use.

       REM PKZIP BBSLST BBSLIST: If you have a N on line 3 of BLIST.CNF
       then take the REM out of this line. This will let PKZIP ZIP the
       BBSLIST file between the time the door is out of RAM and PCBOARD
       takes over giving the largest amount of available RAM to do the job.
       From here you can copy into your download path so users can
       download the BBSLIST from the main board.

       BLIST BLIST.CNF C:\PCB: Runs BBSList and gives it it's parameters
       via the BLIST.CNF file. Change the C:\PCB to reflect the location of
       your main PCBoard directory. Multi-node users will need to remember
       to change this for each node (example C:\PCB, C:\PCB2, etc.)

       CD \PCB: Changes back to your main pcboard directory

       IF EXIST EVENT.BAT EVENT: If you have an event pending, BLIST will
       cut your callers time and run the event.  If you don't run an event,
       you can take this line out.

       BOARD: executes your BOARD.BAT file

    4. Filename:         PROT.DAT
       Purpose:          Protocol Information
       Location:         Must be in the same directory as BLIST.EXE. Required
                         if  you  will  be  allowing downloading inside the
                         door.
       Multi-Node Notes: No special considerations for multiple nodes.  One
                         copy of each file can be shared by all nodes.


       Sample File:

       X,N,Xmodem
       O,N,Xmodem-1k (Old Ymodem)
       Y,N,Ymodem (Ymodem-Batch)
       Z,N,Zmodem
       F,Y,Xmodem-1k-G (Old Ymodem-G)
       G,Y,Ymodem-G (Ymodem-G-Batch)

       This file is similar to PCBoard's PCBPROT.DAT.  Some of the
       entries are different, so users must NOT use the same file.

       The meaning of the entries is as follows:

       X,N,Xmodem

       X= Protocol Letter to be displayed on the protocol menu in the
          door.  This is also the name of the batch file used to dun
          this protocol (X.BAT).

       N= Error correcting modem required? (Y/N).  Put a N on this
          line if the protocol does not require an error correcting
          modem.  Put a Y on this line if it does. This will prevent
          novice callers from accidentally using protocols like Ymodem-G
          with a non-MNP modem.

       If you will not be allowing downloading inside the door, then
       this file, and the download batch protocols are not needed.

       This file is compatible with PROT.DAT used in the TextView Door,
       so if TV.EXE and BLIST.EXE are in the same directory they can
       share this file.

       I would warn against using protocols that require any driver program
       other than DSZ, as many of these programs fail to restore the com
       port to it's original state and may cause lockups on your system.



    5. Filename:          X.BAT, Y.BAT, Z.BAT, G.BAT
       Purpose:           Controls downloading function
       Location:          Same directory  as  your BLIST.EXE file
       Multi-Node  Notes: No need to duplicate these files for every node.
                          The DSZPORT option in the BLIST file will  set
                          the  correct  port  for each node before the .BAT
                          is run.

       Sample File:


       @echo off
       echo off
       SET DSZLOG=%2\DSZ.LOG
       dsz sz %1



       Explanation:

       The names of these files MUST correspond with the menu letters you
       choose in PROT.DAT.  So, if you want to change the letter for
       Ymodem-G (Xmodem-1K-G) from G to F like PCBoard 14 has, you need to
       rename G.BAT to F.BAT.  If you add a protocol such as JMODEM to your
       protocol menu, then you must create a new batch file called J.BAT
       (assuming you assign the menu letter J to the protocol) which
       contains the commands for Jmodem.  Use one of the batch files in the
       BBSList ZIP (X.BAT, Y.BAT, etc) as a model for creating new batch
       files.  If this is handled incorrectly, your users will get a
       message saying that the protocol selected is not available.


       Most of the stuff included in these batch files is standard.  Here's
       a brief explanation of each line in the sample:

       SET DSZLOG=%2\DSZ.LOG: This tells DSZ to create a file on your disk
       that BLIST will use to report cps and transfer errors to your
       CALLERx and DOWNLOAD.TXT files.  This line is mandatory. Please
       don't change it.

       dsz sz %1 : This is the command line given to DSZ.  If
       you are a big DSZ expert, please, be my guest and change this to
       your specs. NOTE: DSZ.COM or DSZ.EXE must be in your DOS path or in
       the same directory as BLIST.EXE.  If you get a "bad command or
       filname" message and the transfer aborts then you have probably not
       put DSZ in the path. Also, DSZ is case sensitive, don't jack around
       with the command line and change it into all upper case.  If you
       aren't a bona fide DSZ expert, you should probably leave these
       command lines alone!  Xmodem-1k-G (Ymodem-G) will only appear on the
       protocol menu if there is an error correcting modem at each end.
       This is handled inside the code.  If there is not an error
       correcting modem on each end, there will only be three protocol
       options (X-Y-Zmodem).  If you also happen to run the my TextView
       door, you can use the same X, Y, Z and G.BAT that you already have
       provided TV.EXE and BLIST.EXE are in the same directory.

       Note: You must enter BLIST in your DOORS.DAT file. Mine looks like
       this:

        PRODOOR,,30
        PROBANK,,30
        PROWHO,,30
        BBS,,30
      * BLIST,,30
        SYSTEMS,,30
        QWKMAIL,,30

    ──────────────────
    NON-STANDARD PORTS
    ─────────────────-

    Users of Multi-Port boards should use the built-in Fossil support
    provided.  To activate this feature, simply place the word FOSSIL in
    line 1 of your configuration file.  Fossil users do not need to set the
    COMBASE and COMIRQ variables described below.

    BList works directly with other non-standard serial port
    configurations. Here are the defaults:

    Port    Base Address    IRQ

    COM1    3F8             IRQ4
    COM2    2F8             IRQ3
    COM3    3E8             IRQ4
    COM4    2E8             IRQ3
    COM5    Undefined       Undefined
    COM6    Undefined       Undefined
    COM7    2E8             IRQ5
    COM8    3E8             IRQ5

    If you use these setups, you can simply allow BList to read your
    port number from your PCBoard setup.

    If your port is setup differently, then BList will look for two
    environment variables called COMBASE and COMIRQ.

    COMBASE must be converted from hex to decimal in order to work properly
    (Example 744 for 2E8).  A utility called HEX2DEC.EXE is included to
    assist in changing your hex port address to decimal.

    COMIRQ is simply the IRQ number being used.

    For example, if you were going to run COM7 with a Base Address of 2F8
    on IRQ2, at the DOS prompt, or in a batch file you would type:

    SET COMBASE=760
    SET COMIRQ=2



    ────────────
    REGISTRATION
    ────────────

    If you run the BBSList Door for more than 30 days, then registration is
    required.  The price of registration is $20.00.

    Online registration by Visa, Mastercard, Discover and American Express
    is available by calling The Ledge PCBoard at [phone]
    HST/V.32bis.

    Registered Sysops will receive a file called BLIST.SYS that will unlock
    the registered features of this and ALL FUTURE VERSIONS of the BBSList
    Door.  Once BLIST.SYS is in place, it automatically registers any
    shareware version of BLIST.EXE simply by running the door.

    Mail-in Registrations should be sent in the form of check or money
    order for $20.00 in U.S. Currency payable to THE LEDGE PCBOARD.
    Please fill out the form located in REGISTER.TXT and mail it with your
    check or money order to:

    The Ledge PCBoard
    Attention: Joseph Sheppard
    6858 Acco Street
    Los Angeles, CA 90040

    I can be reached at my BBS, The Ledge PCBoard [phone]
    HST/V.32bis Or Compuserve 76175,623, US Mail at the address listed
    previously.  I am also the International Host of the U'NI-net
    International Echomail Network and can be contacted in the DOOR-UTIL,
    Sysops or Shareware conferences.

    LEDGE SUPPORT DOOR: Please note that on your first call to the ledge,
    you can enter the Ledge Support door.  It is a TextView door that will
    allow you to view the current "BLHIST.DOC" file and download the very
    latest version of BBSList along with the latest versions of DSZ, SORTF,
    and PKZIP.  You DON'T have to be a registered user on The Ledge to use
    this door! Please let me know you called though so I can validate you
    for future calls.

    While this door performs fine on my system, but I can't guarantee that
    it will work at all on yours.  If you have a problem, contact me and I
    will attempt to solve the problem.

    ──────
    THANKS
    ──────

    Thanks to Samuel Smith, the genius behind Prodoor and ProKit.  ProKit
    made writing my first door quick, easy and fun. Anyone who has ever
    though they would like to write a custom door for their BBS should take
    a look at ProKit.

    Thanks to Charles Shapiro, Sysop of Absolut(e)ly Temporary
    [phone] for his valuable help in beta testing.

    ─────────
    PROBLEMS?
    ─────────

    If you have read this file and still have problems setting up the door,
    take a look at the file called PROBLEMS in this archive.  If your
    problem isn't covered here or in the PROBLEMS file, let me know and I
    will cover it in the next version of BBSList.


    ──────────
    DISCLAIMER
    ──────────

    I make no warranty of any kind, express or implied, including without
    limitation, any warranties of merchantability and/or fitness for a
    particular purpose.  I shall not be liable for any damages, whether
    direct, indirect, special or consequential arising from a failure of
    this program to operate in the manner desired by the user.  I shall not
    be liable for any damage to data or property which may be caused
    directly or indirectly by the use of this program.

    IN NO EVENT WILL I BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST
    PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES
    ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM, OR FOR ANY
    CLAIM BY ANY OTHER PARTY.